/**
 *    Copyright 2009-2015 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.logging;

/**
 * @author Clinton Begin
 */
/**
 * 日志接口
 * 
 */
public interface Log {

	// 和一般的log4j很像，提供日志接口的一些方法,error, debug, warn。
	// 用自己的日志类恐怕是为了通用，不绑死在某个特定的日志框架中
	// 但不是也有类似的slf4j吗？为何还要自己写？可能是不想引入额外的jar包
	/**
	 * 是否开启Debug
	 * 
	 * @return
	 */
	boolean isDebugEnabled();
	/**
	 * 是否开启跟踪
	 * @return
	 */
	boolean isTraceEnabled();

	/**
	 * 错误级别 ---其它运行期错误或不是预期的条件。期望这类信息能立即显示在状态控制台上
	 * 
	 * @param s
	 *            字符串
	 * @param e
	 *            异常
	 */
	void error(String s, Throwable e);

	/**
	 * 错误级别
	 * @param s 字符串
	 */
	void error(String s);
	/**
	 * debug级别 ---系统流程中的细节信息。期望这类信息仅被写入log文件中。
	 * @param s 字符串
	 */
	void debug(String s);
	/**
	 * trace级别 ---更加细节的信息。期望这类信息仅被写入log文件中
	 * @param s 字符串
	 */
	void trace(String s);
	/**
	 * 警告级别
	 * <p>使用了不赞成使用的API、非常拙劣使用API, '几乎就是'错误, 其它运行时不合需要和不合预期的状态但还没必要称为 "错误"。期望这类信息能立即显示在状态控制台上
	 * @param s 字符串
	 */
	void warn(String s);

}
